4.1 自制编辑器

项目实战要点

在之前章节中已经学习了tkinter的大量知识，但仍然有部分知识是没有覆盖到的，换句话说，本教程并不是一本事无巨细的帮助文档，未提到的知识，我将在项目实战中列出，根据具体使用场景来学习。

• 覆写窗口关闭事件

  self.protocol('WM_DELETE_WINDOW', self.exit_editor)
  

• 实现鼠标右键菜单

  def _create_right_popup_menu(self):
      popup_menu = Menu(self.content_text, tearoff=0)
      for it1, it2 in zip(['剪切', '复制', '粘贴', '撤销', '恢复'],
                          ['cut', 'copy', 'paste', 'undo', 'redo']):
          popup_menu.add_command(label=it1, compound='left',
                                 command=self._shortcut_action(it2))
          popup_menu.add_separator()
          popup_menu.add_command(label='全选', command=self.select_all)
          self.content_text.bind('<Button-3>',
                                 lambda event: popup_menu.tk_popup(event.x_root, event.y_root))
  

• 使用闭包处理回调事件

      def _shortcut_action(self, type):
          def handle():
              if type == "new_file":
                  self.new_file()
              elif type == "open_file":
                  self.open_file()
              elif type == "save":
                  self.save()
              elif type == "cut":
                  # ………… 省略部分条件判断
              if type != "copy" and type != "save":
                  self._update_line_num()
  
          return handle
  

• 使用tkinter中的定时回调

  self.content_text.after(200, self._toggle_highlight)
  

• 实现文本搜索功能

  start_pos = self.content_text.search(key, start_pos, nocase=ignore_case, stopindex="end")
  

遗留待完善问题

• 处理文本文件编码

  自制的编辑器目前无法打开不同编码格式的文本文件，需要能自动识别文本文件的编码

  建议考虑使用chardet 模块来识别编码

  import chardet
  
  with open('xxx.py', 'rb') as file:
      print(chardet.detect(file.read(1024)))
  

• 搜索框定位

  搜索框应当根据当前编辑器的相对位置来显示

  # 获取根窗口的绝对位置，依据根窗口的位置计算搜索框的显示位置
  print(self.winfo_rootx(), self.winfo_rooty())
  

• 使用自定义的选项卡控件重构编辑器

  我们之前已经自定义了一个选项卡控件，实现了双创建选项卡，删除选项卡等功能，使用该控件重构编辑器，使编辑器更加实用

搭建 UI 框架

from tkinter import *
from tkinter.ttk import Scrollbar

theme_color = {
    'Default': '#000000.#FFFFFF',
    'Greygarious': '#83406A.#D1D4D1',
    'Aquamarine': '#5B8340.#D1E7E0',
    'Bold Beige': '#4B4620.#FFF0E1',
    'Cobalt Blue': '#ffffBB.#3333aa',
    'Olive Green': '#D1E7E0.#5B8340',
    'Night Mode': '#FFFFFF.#000000',
}


class EditorPlus(Tk):
    def __init__(self):
        super().__init__()
        self._set_window_()
        self._create_menu_bar_()
        self._create_shortcut_bar_()
        self._create_body_()

    # 设置初始窗口的属性
    def _set_window_(self):
        self.title("EditorPlus")
        self.geometry('650x450')

    # 创建整个菜单栏
    def _create_menu_bar_(self):
        menu_bar = Menu(self)
        # 创建文件的联级菜单
        file_menu = Menu(menu_bar, tearoff=0)
        file_menu.add_command(label='新建', accelerator='Ctrl+N')
        file_menu.add_command(label='打开', accelerator='Ctrl+O')
        file_menu.add_command(label='保存', accelerator='Ctrl+S')
        file_menu.add_command(label='另存为', accelerator='Shift+Ctrl+S')
        file_menu.add_separator()
        file_menu.add_command(label='退出', accelerator='Alt+F4')

        # 在菜单栏上添加菜单标签，并将该标签与相应的联级菜单关联起来
        menu_bar.add_cascade(label='文件', menu=file_menu)

        # 创建编辑的联级菜单
        edit_menu = Menu(menu_bar, tearoff=0)
        edit_menu.add_command(label='撤销', accelerator='Ctrl+Z')
        edit_menu.add_command(label='恢复', accelerator='Ctrl+Y')
        edit_menu.add_separator()
        edit_menu.add_command(label='剪切', accelerator='Ctrl+X')
        edit_menu.add_command(label='复制', accelerator='Ctrl+C')
        edit_menu.add_command(label='粘贴', accelerator='Ctrl+V')
        edit_menu.add_separator()
        edit_menu.add_command(label='查找', accelerator='Ctrl+F')
        edit_menu.add_separator()
        edit_menu.add_command(label='全选', accelerator='Ctrl+A')
        menu_bar.add_cascade(label='编辑', menu=edit_menu)

        # 视图菜单
        view_menu = Menu(menu_bar, tearoff=0)
        show_line_number = IntVar()
        show_line_number.set(1)
        view_menu.add_checkbutton(label='显示行号', variable=show_line_number)

        highlight_line = IntVar()
        view_menu.add_checkbutton(label='高亮当前行', onvalue=1, offvalue=0, variable=highlight_line)

        # 在主题菜单中再添加一个子菜单列表
        themes_menu = Menu(menu_bar, tearoff=0)
        view_menu.add_cascade(label='主题', menu=themes_menu)

        theme_choice = StringVar()
        theme_choice.set('Default')
        for k in sorted(theme_color):
            themes_menu.add_radiobutton(label=k, variable=theme_choice)

        menu_bar.add_cascade(label='视图', menu=view_menu)

        about_menu = Menu(menu_bar, tearoff=0)
        about_menu.add_command(label='关于')
        about_menu.add_command(label='帮助')
        menu_bar.add_cascade(label='关于', menu=about_menu)
        self["menu"] = menu_bar

    # 创建快捷菜单栏
    def _create_shortcut_bar_(self):
        shortcut_bar = Frame(self, height=25, background='#20b2aa')
        shortcut_bar.pack(fill='x')

    # 创建程序主体
    def _create_body_(self):
        # 创建行号栏 （takefocus=0 屏蔽焦点）
        line_number_bar = Text(self, width=4, padx=3, takefocus=0, border=0,
                               background='#F0E68C', state='disabled')
        line_number_bar.pack(side='left', fill='y')

        # 创建文本输入框
        content_text = Text(self, wrap='word')
        content_text.pack(expand='yes', fill='both')

        # 创建滚动条
        scroll_bar = Scrollbar(content_text)
        scroll_bar["command"] = content_text.yview
        content_text["yscrollcommand"] = scroll_bar.set
        scroll_bar.pack(side='right', fill='y')


if "__main__" == __name__:
    app = EditorPlus()
    app.mainloop()

完善编辑器的功能

实现了基本的界面框架之后，只需将相应的功能一个一个添加上去即可。

完整项目源码